REST API Macroservice AsyncAPI 1.0.0 documentation

AsyncAPI for the REST API macroservice. This service both publishes and subscribes to several events and also exposes Server-Sent Events (SSE) to the frontend (HTTP-based push).

Servers

${CLOUDAMQP_URL:///amqp://admin:admin@localhost:5672}amqprabbitmq

RabbitMQ broker (env CLOUDAMQP_URL supported)

Operations

PUB StalkingAnalyzeRequestedEvent

Queue published when a stalking analysis is requested (service publishes).

Publish request to start stalking analysis

Operation IDpublishStalkingAnalyzeRequested

Available only on servers:

rabbitmq

Accepts the following message:

StalkingAnalyzeRequested

Request to start stalking analysis for given social URLs.

application/json

Message IDStalkingAnalyzeRequested

object

facebookUrl

string

instagramUrl

string

tiktokUrl

string

youtubeUrl

string

xUrl

string

linkedinUrl

string

chatId

required

string

Additional properties are allowed.

Examples

{
  "facebookUrl": "string",
  "instagramUrl": "string",
  "tiktokUrl": "string",
  "youtubeUrl": "string",
  "xUrl": "string",
  "linkedinUrl": "string",
  "chatId": "string"
}

This example has been generated automatically.

PUB ChatStartInterviewEvent

Queue published when chat interview starts (service publishes).

Publish start of chat interview

Operation IDpublishChatStartInterview

Available only on servers:

rabbitmq

Accepts the following message:

ChatStartInterview

Start of the chat interview flow.

application/json

Message IDChatStartInterview

object

array<object>

Additional properties are allowed.

Examples

{
  "context": {},
  "history": [
    {}
  ]
}

This example has been generated automatically.

PUB ChatUserAnsweredEvent

Queue published when user answers in chat (service publishes).

Publish user's chat answer

Operation IDpublishChatUserAnswered

Available only on servers:

rabbitmq

Accepts the following message:

ChatUserAnswered

User answered during chat interview.

application/json

Message IDChatUserAnswered

object

array<object>

Additional properties are allowed.

Examples

{
  "context": {},
  "messages": [
    {}
  ]
}

This example has been generated automatically.

PUB GiftGenerateRequestedEvent

Queue published to request gift generation (service publishes).

Publish request to generate gift ideas

Operation IDpublishGiftGenerateRequested

Available only on servers:

rabbitmq

Accepts the following message:

GiftGenerateRequested

Request to generate gift ideas.

application/json

Message IDGiftGenerateRequested

object

array<string>

chatId

required

string

object

Additional properties are allowed.

Examples

{
  "keywords": [
    "string"
  ],
  "chatId": "string",
  "profile": {}
}

This example has been generated automatically.

SUB StalkingCompletedEvent

Queue the service subscribes to when stalking is completed.

Consume stalking completed events

Operation IDhandleStalkingCompleted

Available only on servers:

rabbitmq

Accepts the following message:

StalkingCompleted

Stalking analysis completed with extracted keywords.

application/json

Message IDStalkingCompleted

object

array<string>

completedAt

required

string

format: date-time

chatId

required

string

Additional properties are allowed.

Examples

{
  "keywords": [
    "string"
  ],
  "completedAt": "2019-08-24T14:15:22Z",
  "chatId": "string"
}

This example has been generated automatically.

SUB ChatQuestionAskedEvent

Queue the service subscribes to for question asked notifications.

Consume chat question asked

Operation IDhandleChatQuestionAsked

Available only on servers:

rabbitmq

Accepts the following message:

ChatQuestionAsked

Question asked by the user during chat.

application/json

Message IDChatQuestionAsked

object

question

required

string

required

object

array<string>

chatId

string

Additional properties are allowed.

Examples

{
  "question": "string",
  "context": {
    "keywords": [
      "string"
    ],
    "chatId": "string"
  }
}

This example has been generated automatically.

SUB ChatInterviewCompletedEvent

Queue the service subscribes to for interview completion.

Consume chat interview completed

Operation IDhandleChatInterviewCompleted

Available only on servers:

rabbitmq

Accepts the following message:

ChatInterviewCompleted

Interview flow finished with computed profile.

application/json

Message IDChatInterviewCompleted

object

required

object

required

object

Additional properties are allowed.

Examples

{
  "context": {},
  "profile": {}
}

This example has been generated automatically.

SUB GiftReadyEvent

Queue the service subscribes to to receive generated gift ideas.

Consume generated gift ideas

Operation IDhandleGiftReady

Available only on servers:

rabbitmq

Accepts the following message:

GiftReady

Generated gift ideas ready to consume.

application/json

Message IDGiftReady

object

required

array<object>

object

image

string

format: uri

title

string

description

string

link

string

format: uri

object

value

number

label

string

currency

string

negotiable

boolean

Additional properties are allowed.

chatId

required

string

Additional properties are allowed.

Examples

{
  "giftIdeas": [
    {
      "image": "http://example.com",
      "title": "string",
      "description": "string",
      "link": "http://example.com",
      "price": {
        "value": 0,
        "label": "string",
        "currency": "string",
        "negotiable": true
      }
    }
  ],
  "chatId": "string"
}

This example has been generated automatically.

SUB ChatInappropriateRequestEvent

Queue the service subscribes to for inappropriate requests.

Consume inappropriate requests

Operation IDhandleChatInappropriateRequest

Available only on servers:

rabbitmq

Accepts the following message:

ChatInappropriateRequest

The request was flagged as inappropriate.

application/json

Message IDChatInappropriateRequest

object

Examples

{
  "reason": "string",
  "chatId": "string"
}

This example has been generated automatically.

Messages

#1StalkingAnalyzeRequested

Request to start stalking analysis for given social URLs.

application/json

Message IDStalkingAnalyzeRequested

object

facebookUrl

string

instagramUrl

string

tiktokUrl

string

youtubeUrl

string

xUrl

string

linkedinUrl

string

chatId

required

string

Additional properties are allowed.

#2ChatStartInterview

Start of the chat interview flow.

application/json

Message IDChatStartInterview

object

array<object>

Additional properties are allowed.

#3ChatUserAnswered

User answered during chat interview.

application/json

Message IDChatUserAnswered

object

array<object>

Additional properties are allowed.

#4GiftGenerateRequested

Request to generate gift ideas.

application/json

Message IDGiftGenerateRequested

object

array<string>

chatId

required

string

object

Additional properties are allowed.

#5StalkingCompleted

Stalking analysis completed with extracted keywords.

application/json

Message IDStalkingCompleted

object

array<string>

completedAt

required

string

format: date-time

chatId

required

string

Additional properties are allowed.

#6ChatQuestionAsked

Question asked by the user during chat.

application/json

Message IDChatQuestionAsked

object

question

required

string

required

object

array<string>

chatId

string

Additional properties are allowed.

#7ChatInterviewCompleted

Interview flow finished with computed profile.

application/json

Message IDChatInterviewCompleted

object

required

object

required

object

Additional properties are allowed.

#8GiftReady

Generated gift ideas ready to consume.

application/json

Message IDGiftReady

object

required

array<object>

object

image

string

format: uri

title

string

description

string

link

string

format: uri

object

value

number

label

string

currency

string

negotiable

boolean

Additional properties are allowed.

chatId

required

string

Additional properties are allowed.

#9ChatInappropriateRequest

The request was flagged as inappropriate.

application/json

Message IDChatInappropriateRequest

object